home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Tools / Dev / Bgui / AutoDoc / stringclass.doc < prev    next >
Encoding:
Text File  |  2000-05-09  |  3.1 KB  |  140 lines
  1. TABLE OF CONTENTS
  2.  
  3. stringclass/--background--
  4. stringclass/SM_FORMAT_STRING
  5. stringclass/STRINGA_Integer[xxx]
  6. stringclass/STRINGA_MinCharsVisible
  7. stringclass/STRINGA_StringInfo
  8.  
  9. stringclass/--background--
  10.  
  11. NAME
  12.  
  13.   Class:      stringclass
  14.   Superclass: baseclass
  15.   Include File: <libraries/bgui.h>
  16.  
  17. FUNCTION
  18.  
  19.   To provide a gadget similar to the gadtools.library string and
  20.   integer gadget kinds. Objects of this class send out the following
  21.   attribute pairs in their notification events:
  22.  
  23.   GA_ID - Gadget object ID.
  24.   STRINGA_TextVal - Gadget object string contents (string objects).
  25.   STRINGA_LongVal - Gadget object integer contents (integer objects).
  26.  
  27. NOTE
  28.  
  29.   All system strgclass attributes are also supported by this class.
  30.   Please refer to the documentation on the strgclass for more
  31.   information on these attributes.
  32.  
  33. stringclass/SM_FORMAT_STRING
  34.  
  35. NAME
  36.  
  37.   SM_FORMAT_STRING -- Format object contents.
  38.  
  39. SYNOPSIS
  40.  
  41.   err = DoMethod( obj, SM_FORMAT_STRING, gi, fstr, ... )
  42.  
  43.   ULONG  err;
  44.   struct GadgetInfo *gi;
  45.   UBYTE *fstr;
  46.  
  47. FUNCTION
  48.  
  49.   This method may be used to set a formatted string in a string object.
  50.   The formatted string may also contain any locale.library compatible
  51.   formatting codes.
  52.  
  53. INPUTS
  54.  
  55.   gi - This must point to a valid GadgetInfo structure if the
  56.     change must also be shown visually on screen. The
  57.     BGUI_DoGadgetMethod() call will automatically construct this
  58.     for you.
  59.  
  60.   fstr - This must point to a 0-terminated string which contains the
  61.     formatting codes. Also all locale.library FormatString()
  62.     formatting codes are supported when the locale.library is
  63.     available.
  64.  
  65.   Following the format string you can put the formatting arguments which
  66.   may be needed to result in a correct output.
  67.  
  68. NOTE
  69.  
  70.   This method will only work on string objects, and not on integer objects.
  71.  
  72. RESULT
  73.  
  74.   err - TRUE upon success and FALSE upon failure.
  75.  
  76. SEE ALSO
  77.  
  78.   bgui.library/BGUI_DoGadgetMethodA()
  79.  
  80. stringclass/STRINGA_Integer[xxx]
  81.  
  82. NAME
  83.  
  84.   STRINGA_IntegerMin, STRINGA_IntegerMax -- ( ULONG ) ** V39 **
  85.  
  86. FUNCTION
  87.  
  88.   To set the minimum and maximum values which the integer object can
  89.   hold. When a STRINGA_LongVal is set which is out of this range the
  90.   value is adjusted to be inside these boundaries. Also when the user
  91.   enters a value outside these boundaries the screen will flash and the
  92.   entered value is adjusted and not accepted.
  93.  
  94. DEFAULTS
  95.  
  96.   0xEFFFFFFF minimum and 0x0FFFFFFF maximum.
  97.  
  98. APPLICABILITY
  99.  
  100.   (ISU).
  101.  
  102. stringclass/STRINGA_MinCharsVisible
  103.  
  104. NAME
  105.  
  106.   STRINGA_MinCharsVisible -- ( ULONG ) ** V39 **
  107.  
  108. FUNCTION
  109.  
  110.   To specify the minimum number of characters which should always
  111.   stay visible. This number is involved in calculating the object's
  112.   minimum size. The object won't resize any smaller if that would mean
  113.   that the space required to show this number of characters would become
  114.   insufficient.
  115.  
  116. DEFAULT
  117.  
  118.   2.
  119.  
  120. APPLICABILITY
  121.  
  122.   (I).
  123.  
  124. stringclass/STRINGA_StringInfo
  125.  
  126. NAME
  127.  
  128.   STRINGA_StringInfo -- ( struct StringInfo * ) ** V40 **
  129.  
  130. FUNCTION
  131.  
  132.   To get a pointer to the string object's special info structure.
  133.   Peeking the objects SpecialInfo field will not work! You must OM_GET
  134.   this attribute.
  135.  
  136. APPLICABILITY
  137.  
  138.   (G).
  139.  
  140.